UpdateService

The UpdateService web serviceClosed XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to update either SubscriptionClosed A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription Service Details for a given Subscription Number, or AgreementClosed In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated. Service Details for a given Agreement Number.

This service should be used in conjunction with the Service subset of the Query Subscription Details or Query Agreement Details services.

The userClosed A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Subscription Number (or Agreement Number), Service Code and Effective Date in order to update the Service Details.

Invalid requests are rejected with an error message.

UpdateService Request

The UpdateService tag instructs the Services Service to update service details. This request contains the following elements:

Element Name

Content Type

Description

Required?

UpdateServiceData

Container

See Update Service Data Request Container for details.

Mandatory
UpdateServiceData Request Container

The UpdateServiceData request container has the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

Returned unmodified in the response. The client may use this identifier to correlate the request and the response.

Optional

CustomerLevel

String

Valid values are:

  • SUBSCRIPTION
  • ACCOUNT

Mandatory

CustomerLevelReference

String8

Include Subscription Number, Account Number or Agreement Number, depending on the customer level.

Mandatory

ServiceCode

String6

This details the code attributed to the Service as it appears on the invoice (for example, LINECH).

Mandatory

EffectiveDate

date

YYYY-MM-DDZ

Mandatory

UpdateServiceBasic

Container

See Update Service Basic Request Container for details.

Optional

AuditRecord

Container

See AuditRecord Request Container for details.

Optional
UpdateServiceBasic Request Container

The UpdateServiceBasic request container has the following elements:

Element Name

Content Type

Description

Required?

ServicePrice

Currency (Decimal)
  • Min Inclusive: 0.01
  • Max Inclusive: 999999999.99

Optional

ExpiryDate

Date

YYYY-MM-DDZ

Sets the expiry date of the service. Where the expiryDate is already set, this can be cleared if this is in the future by passing through the zero date 1899-01-01.

Optional

Description

String30

The description to be applied to the Subscription service record for the subscriber.

  • If this value is not supplied, the description is set to that from the Tariff Service File or Service Configuration (as per the current logic).
  • Where a description is supplied, the calling system can pass any value of less than 30 characters.

    The Description value should not be populated for agreement services. If supplied, the value will not be applied.

Optional

LongDescription

String120

This details a longer descriptive text attributed to the Service (120-characters).

Optional

SuppressRemainingCharge

Boolean

This is a Yes/No option which is used by Invoice Production to determine whether or not to apply the Contract Expiry Charge to the subscriber as part of generating the invoice.

Optional

ContractReference

String12

This is a Reference ID that can be assigned to the individual service contract.

Optional

LastAmendedDate

dateTime

YYYY-MM-DDThh:mm:ssZ

Mandatory
AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name

Content Type

Description

Required?

UserID

String10

User ID associated with the profile. This is the ID which the calling program adds to the records that are created.

Mandatory

Program

String10

The program name should be hard coded in the calling application to uniquely identify that application.

Mandatory

UpdateService Response

UpdateService response is the response to the UpdateService Request. This contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

Returned unmodified in the response. The client may use this identifier to correlate the request and the response.

Optional